CreateLinkSpec

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODDraft

CreateLinkSpec
The CreateLinkSpec method creates a link-specification object for the specified part.
ODLinkSpec CreateLinkSpec (in ODPart part,
                           in ODByteArray data);
part
A reference to the source part creating the link specification, or kODNULL to create an empty link specification.
data
A byte array whose buffer contains arbitrary data to be placed in the link specification, or kODNULL to create an empty link specification.
return value
A reference to the newly created link-specification object.

DISCUSSION
For a link to be created, this method must be called by both the source part and the destination part of a data transfer operation.

A source part that supports linking calls this method to create a link-specification object. The part parameter is a reference to the source part. The buffer of the data parameter can contain any data that the source part's CreateLink method may need for creating the specified link.
The user who pastes or drops the source data to a destination part can request a link by means of the Paste As dialog box. When this happens, the destination part calls this method to create an empty link-specification object. The part and data parameters are both null. The destination part then calls the ReadLinkSpec method of the returned link-specification object to read the link-specification data. The destination part creates the link by passing the link-specification object to its draft's AcquireLink method.

The calling part should delete the link-specification object when it has finished using it.
If this method executes successfully, it marks this draft as dirty.

SEE ALSO
The ODByteArray type (page 877).
The ODDraft::AcquireLink method (page 154).
The ODLinkSpec::ReadLinkSpec method (page 392).
The ODLinkSpec::WriteLinkSpec method (page 393).
The ODPart::CreateLink method (page 492).
The ODLink class (page 348).
The ODLinkSpec class (page 390).
"Link Specification" on page 317 in OpenDoc Programmer's Guide.
"Creating a Link at the Destination" on page 384 in OpenDoc Programmer's Guide.
Table 11-1 on page 466 in OpenDoc Programmer's Guide.